۳۰ مرداد ۱۴۰۴فارسی

نگاهی عمیق به دکوراتورهای جاوا اسکریپت، بررسی سینتکس، کاربردهای برنامه‌نویسی فراداده، بهترین شیوه‌ها و تأثیر آن بر قابلیت نگهداری کد. شامل مثال‌های عملی و ملاحظات آینده.

دکوراتورهای جاوا اسکریپت: پیاده‌سازی برنامه‌نویسی فراداده

دکوراتورهای جاوا اسکریپت یک ویژگی قدرتمند هستند که به شما امکان می‌دهند فراداده اضافه کرده و رفتار کلاس‌ها، متدها، ویژگی‌ها و پارامترها را به روشی اعلانی و قابل استفاده مجدد اصلاح کنید. آن‌ها یک پروپوزال مرحله ۳ در فرآیند استانداردهای ECMAScript هستند و به طور گسترده با تایپ اسکریپت استفاده می‌شوند که پیاده‌سازی خاص خود (کمی متفاوت) را دارد. این مقاله یک نمای کلی جامع از دکوراتورهای جاوا اسکریپت ارائه می‌دهد و بر نقش آن‌ها در برنامه‌نویسی فراداده تمرکز کرده و استفاده از آن‌ها را با مثال‌های عملی نشان می‌دهد.

دکوراتورهای جاوا اسکریپت چه هستند؟

دکوراتورها یک الگوی طراحی هستند که عملکرد یک شیء را بدون تغییر ساختار آن تقویت یا اصلاح می‌کنند. در جاوا اسکریپت، دکوراتورها انواع خاصی از اعلان‌ها هستند که می‌توانند به کلاس‌ها، متدها، اکسسورها (accessors)، ویژگی‌ها یا پارامترها متصل شوند. آن‌ها از نماد @ و به دنبال آن یک تابع استفاده می‌کنند که هنگام تعریف عنصر تزئین‌شده (decorated) اجرا می‌شود.

دکوراتورها را به عنوان توابعی در نظر بگیرید که عنصر تزئین‌شده را به عنوان ورودی می‌گیرند و یک نسخه اصلاح‌شده از آن عنصر را برمی‌گردانند یا یک اثر جانبی (side effect) بر اساس آن انجام می‌دهند. این روش یک راه تمیز و زیبا برای افزودن عملکرد بدون تغییر مستقیم کلاس یا تابع اصلی فراهم می‌کند.

مفاهیم کلیدی:

تابع دکوراتور: تابعی که قبل از آن نماد @ قرار می‌گیرد. این تابع اطلاعاتی در مورد عنصر تزئین‌شده دریافت می‌کند و می‌تواند آن را اصلاح کند.
عنصر تزئین‌شده: کلاس، متد، اکسسور، ویژگی یا پارامتری که تزئین می‌شود.
فراداده (Metadata): داده‌ای که داده دیگر را توصیف می‌کند. دکوراتورها اغلب برای مرتبط کردن فراداده با عناصر کد استفاده می‌شوند.

سینتکس و ساختار

سینتکس پایه یک دکوراتور به شرح زیر است:

@decorator
class MyClass {
  // اعضای کلاس
}

در اینجا، @decorator تابع دکوراتور و MyClass کلاس تزئین‌شده است. تابع دکوراتور هنگام تعریف کلاس فراخوانی می‌شود و می‌تواند به تعریف کلاس دسترسی داشته و آن را اصلاح کند.

دکوراتورها همچنین می‌توانند آرگومان‌هایی را بپذیرند که به خود تابع دکوراتور ارسال می‌شوند:

@loggable(true, "Custom Message")
class MyClass {
  // اعضای کلاس
}

در این حالت، loggable یک تابع کارخانه‌ای دکوراتور (decorator factory) است که آرگومان‌ها را گرفته و تابع دکوراتور واقعی را برمی‌گرداند. این امکان ایجاد دکوراتورهای انعطاف‌پذیرتر و قابل تنظیم‌تر را فراهم می‌کند.

انواع دکوراتورها

بسته به اینکه چه چیزی را تزئین می‌کنند، انواع مختلفی از دکوراتورها وجود دارد:

دکوراتورهای کلاس: برای کلاس‌ها اعمال می‌شوند.
دکوراتورهای متد: برای متدهای داخل یک کلاس اعمال می‌شوند.
دکوراتورهای اکسسور: برای اکسسورهای getter و setter اعمال می‌شوند.
دکوراتورهای ویژگی: برای ویژگی‌های کلاس اعمال می‌شوند.
دکوراتورهای پارامتر: برای پارامترهای یک متد اعمال می‌شوند.

دکوراتورهای کلاس

دکوراتورهای کلاس برای اصلاح یا تقویت رفتار یک کلاس استفاده می‌شوند. آنها سازنده (constructor) کلاس را به عنوان آرگومان دریافت می‌کنند و می‌توانند یک سازنده جدید را برای جایگزینی با سازنده اصلی برگردانند. این امکان را به شما می‌دهد تا عملکردهایی مانند لاگ‌گیری، تزریق وابستگی یا مدیریت وضعیت را اضافه کنید.

مثال:

function loggable(constructor: Function) {
  console.log("Class " + constructor.name + " was created.");
}

@loggable
class User {
  name: string;

  constructor(name: string) {
    this.name = name;
  }
}

const user = new User("Alice"); // خروجی: Class User was created.

در این مثال، دکوراتور loggable هر زمان که یک نمونه جدید از کلاس User ایجاد شود، پیامی را در کنسول لاگ می‌کند. این می‌تواند برای اشکال‌زدایی یا نظارت مفید باشد.

دکوراتورهای متد

دکوراتورهای متد برای اصلاح رفتار یک متد در داخل یک کلاس استفاده می‌شوند. آنها آرگومان‌های زیر را دریافت می‌کنند:

target: پروتوتایپ کلاس.
propertyKey: نام متد.
descriptor: توصیفگر ویژگی (property descriptor) برای متد.

توصیفگر به شما امکان می‌دهد تا به رفتار متد دسترسی داشته و آن را اصلاح کنید، مانند پیچیدن آن با منطق اضافی یا تعریف مجدد کامل آن.

مثال:

function logMethod(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
  const originalMethod = descriptor.value;

  descriptor.value = function (...args: any[]) {
    console.log(`Calling method ${propertyKey} with arguments: ${args}`);
    const result = originalMethod.apply(this, args);
    console.log(`Method ${propertyKey} returned: ${result}`);
    return result;
  };
  return descriptor;
}

class Calculator {
  @logMethod
  add(a: number, b: number): number {
    return a + b;
  }
}

const calculator = new Calculator();
const sum = calculator.add(5, 3); // لاگ‌هایی برای فراخوانی متد و مقدار بازگشتی خروجی می‌دهد

در این مثال، دکوراتور logMethod آرگومان‌ها و مقدار بازگشتی متد را لاگ می‌کند. این می‌تواند برای اشکال‌زدایی و نظارت بر عملکرد مفید باشد.

دکوراتورهای اکسسور

دکوراتورهای اکسسور شبیه به دکوراتورهای متد هستند اما برای اکسسورهای getter و setter اعمال می‌شوند. آنها همان آرگومان‌های دکوراتورهای متد را دریافت می‌کنند و به شما امکان می‌دهند رفتار اکسسور را اصلاح کنید.

مثال:

function validate(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
  const originalSet = descriptor.set;

  descriptor.set = function (value: any) {
    if (value < 0) {
      throw new Error("Value must be non-negative.");
    }
    originalSet.call(this, value);
  };
}

class Temperature {
  private _celsius: number;

  constructor(celsius: number) {
    this._celsius = celsius;
  }

  @validate
  set celsius(value: number) {
    this._celsius = value;
  }

  get celsius(): number {
    return this._celsius;
  }
}

const temperature = new Temperature(25);
temperature.celsius = 30; // معتبر
// temperature.celsius = -10; // خطا ایجاد می‌کند

در این مثال، دکوراتور validate اطمینان حاصل می‌کند که مقدار دما غیرمنفی باشد. این می‌تواند برای اعمال یکپارچگی داده‌ها مفید باشد.

دکوراتورهای ویژگی

دکوراتورهای ویژگی برای اصلاح رفتار یک ویژگی کلاس استفاده می‌شوند. آنها آرگومان‌های زیر را دریافت می‌کنند:

target: پروتوتایپ کلاس (برای ویژگی‌های نمونه) یا سازنده کلاس (برای ویژگی‌های استاتیک).
propertyKey: نام ویژگی.

دکوراتورهای ویژگی می‌توانند برای تعریف فراداده یا اصلاح توصیفگر ویژگی استفاده شوند.

مثال:

function readonly(target: any, propertyKey: string) {
  Object.defineProperty(target, propertyKey, {
    writable: false,
  });
}

class Configuration {
  @readonly
  apiUrl: string = "https://api.example.com";
}

const config = new Configuration();
// config.apiUrl = "https://newapi.example.com"; // در حالت strict mode خطا ایجاد می‌کند

در این مثال، دکوراتور readonly ویژگی apiUrl را فقط خواندنی می‌کند و از تغییر آن پس از مقداردهی اولیه جلوگیری می‌کند. این می‌تواند برای تعریف مقادیر پیکربندی غیرقابل تغییر مفید باشد.

دکوراتورهای پارامتر

دکوراتورهای پارامتر برای اصلاح رفتار یک پارامتر متد استفاده می‌شوند. آنها آرگومان‌های زیر را دریافت می‌کنند:

target: پروتوتایپ کلاس (برای متدهای نمونه) یا سازنده کلاس (برای متدهای استاتیک).
propertyKey: نام متد.
parameterIndex: ایندکس پارامتر در لیست پارامترهای متد.

دکوراتورهای پارامتر کمتر از انواع دیگر دکوراتورها استفاده می‌شوند، اما می‌توانند برای اعتبارسنجی پارامترهای ورودی یا تزریق وابستگی‌ها مفید باشند.

مثال:

function required(target: any, propertyKey: string, parameterIndex: number) {
  const existingRequiredParameters: number[] = Reflect.getOwnMetadata(propertyKey, target, "required") || [];
  existingRequiredParameters.push(parameterIndex);
  Reflect.defineMetadata(propertyKey, existingRequiredParameters, target, "required");
}

function validateMethod(target: any, propertyName: string, descriptor: PropertyDescriptor) {
  let method = descriptor.value!;

  descriptor.value = function () {
    let requiredParameters: number[] = Reflect.getOwnMetadata(propertyName, target, "required");
    if (requiredParameters) {
      for (let parameterIndex of requiredParameters) {
        if (arguments[parameterIndex] === null || arguments[parameterIndex] === undefined) {
          throw new Error(`Missing required argument at index ${parameterIndex}`);
        }
      }
    }

    return method.apply(this, arguments);
  };
}


class ArticleService {
  create(
    @required title: string,
    @required content: string
  ): void {
    console.log(`Creating article with title: ${title} and content: ${content}`);
  }
}

const service = new ArticleService();
// service.create("My Article", null); // خطا ایجاد می‌کند
service.create("My Article", "Article Content"); // معتبر

در این مثال، دکوراتور required پارامترها را به عنوان الزامی علامت‌گذاری می‌کند و دکوراتور validateMethod اطمینان حاصل می‌کند که این پارامترها null یا undefined نباشند. این می‌تواند برای اعمال اعتبارسنجی ورودی متد مفید باشد.

برنامه‌نویسی فراداده با دکوراتورها

یکی از قدرتمندترین موارد استفاده از دکوراتورها، برنامه‌نویسی فراداده است. فراداده، داده‌ای در مورد داده است. در زمینه برنامه‌نویسی، این داده‌ای است که ساختار، رفتار و هدف کد شما را توصیف می‌کند. دکوراتورها روشی تمیز و اعلانی برای مرتبط کردن فراداده با کلاس‌ها، متدها، ویژگی‌ها و پارامترها فراهم می‌کنند.

The Reflect Metadata API

Reflect Metadata API یک API استاندارد است که به شما امکان ذخیره و بازیابی فراداده‌های مرتبط با اشیاء را می‌دهد. این API توابع زیر را فراهم می‌کند:

Reflect.defineMetadata(key, value, target, propertyKey): فراداده‌ای را برای یک ویژگی خاص از یک شیء تعریف می‌کند.
Reflect.getMetadata(key, target, propertyKey): فراداده‌ای را برای یک ویژگی خاص از یک شیء بازیابی می‌کند.
Reflect.hasMetadata(key, target, propertyKey): بررسی می‌کند که آیا فراداده برای یک ویژگی خاص از یک شیء وجود دارد یا خیر.
Reflect.deleteMetadata(key, target, propertyKey): فراداده‌ای را برای یک ویژگی خاص از یک شیء حذف می‌کند.

شما می‌توانید از این توابع در ترکیب با دکوراتورها برای مرتبط کردن فراداده با عناصر کد خود استفاده کنید.

مثال: تعریف و بازیابی فراداده

import 'reflect-metadata';

const logKey = "log";

function log(message: string) {
  return function (target: any, key: string, descriptor: PropertyDescriptor) {
    Reflect.defineMetadata(logKey, message, target, key);

    const originalMethod = descriptor.value;
    descriptor.value = function (...args: any[]) {
      console.log(Reflect.getMetadata(logKey, target, key));
      const result = originalMethod.apply(this, args);
      return result;
    }

    return descriptor;
  }
}

class Example {
  @log("Executing method")
  myMethod(arg: string): string {
    return `Method called with ${arg}`;
  }
}

const example = new Example();
example.myMethod("Hello"); // خروجی: Executing method, Method called with Hello

در این مثال، دکوراتور log از Reflect Metadata API برای مرتبط کردن یک پیام لاگ با متد myMethod استفاده می‌کند. هنگامی که متد فراخوانی می‌شود، دکوراتور پیام را بازیابی کرده و در کنسول لاگ می‌کند.

موارد استفاده برای برنامه‌نویسی فراداده

برنامه‌نویسی فراداده با دکوراتورها کاربردهای عملی زیادی دارد، از جمله:

سریال‌سازی و دی‌سریال‌سازی (Serialization/Deserialization): ویژگی‌ها را با فراداده حاشیه‌نویسی کنید تا نحوه سریال‌سازی یا دی‌سریال‌سازی آنها به/از JSON یا فرمت‌های دیگر را کنترل کنید. این می‌تواند هنگام کار با داده‌های APIهای خارجی یا پایگاه‌های داده، به ویژه در سیستم‌های توزیع‌شده که نیاز به تبدیل داده در پلتفرم‌های مختلف دارند (مثلاً تبدیل فرمت‌های تاریخ بین استانداردهای منطقه‌ای مختلف) مفید باشد. یک پلتفرم تجارت الکترونیک را تصور کنید که با آدرس‌های حمل و نقل بین‌المللی سر و کار دارد، جایی که ممکن است از فراداده برای مشخص کردن فرمت صحیح آدرس و قوانین اعتبارسنجی برای هر کشور استفاده کنید.
تزریق وابستگی (Dependency Injection): از فراداده برای شناسایی وابستگی‌هایی که باید به یک کلاس تزریق شوند استفاده کنید. این کار مدیریت وابستگی‌ها را ساده کرده و کوپلینگ سست (loose coupling) را ترویج می‌کند. یک معماری میکروسرویس را در نظر بگیرید که در آن سرویس‌ها به یکدیگر وابسته هستند. دکوراتورها و فراداده می‌توانند تزریق پویای کلاینت‌های سرویس را بر اساس پیکربندی تسهیل کنند و امکان مقیاس‌پذیری و تحمل خطای آسان‌تر را فراهم کنند.
اعتبارسنجی (Validation): قوانین اعتبارسنجی را به عنوان فراداده تعریف کنید و از دکوراتورها برای اعتبارسنجی خودکار داده‌ها استفاده کنید. این کار یکپارچگی داده‌ها را تضمین کرده و کد تکراری (boilerplate) را کاهش می‌دهد. به عنوان مثال، یک برنامه مالی جهانی باید با مقررات مالی منطقه‌ای مختلف مطابقت داشته باشد. فراداده می‌تواند قوانین اعتبارسنجی را برای فرمت‌های ارز، محاسبات مالیاتی و محدودیت‌های تراکنش بر اساس موقعیت مکانی کاربر تعریف کند و از انطباق با قوانین محلی اطمینان حاصل کند.
مسیریابی و میان‌افزار (Routing and Middleware): از فراداده برای تعریف مسیرها و میان‌افزار برای برنامه‌های وب استفاده کنید. این کار پیکربندی برنامه شما را ساده کرده و آن را قابل نگهداری‌تر می‌کند. یک شبکه توزیع محتوای (CDN) جهانی می‌تواند از فراداده برای تعریف سیاست‌های کش (caching) و قوانین مسیریابی بر اساس نوع محتوا و موقعیت مکانی کاربر استفاده کند و عملکرد را بهینه کرده و تأخیر را برای کاربران در سراسر جهان کاهش دهد.
احراز هویت و مجوزدهی (Authorization and Authentication): نقش‌ها، مجوزها و الزامات احراز هویت را با متدها و کلاس‌ها مرتبط کنید و سیاست‌های امنیتی اعلانی را تسهیل کنید. یک شرکت چندملیتی با کارمندان در بخش‌ها و مکان‌های مختلف را تصور کنید. دکوراتورها می‌توانند قوانین کنترل دسترسی را بر اساس نقش، بخش و موقعیت مکانی کاربر تعریف کنند و اطمینان حاصل کنند که فقط پرسنل مجاز می‌توانند به داده‌ها و قابلیت‌های حساس دسترسی داشته باشند.

بهترین شیوه‌ها

هنگام استفاده از دکوراتورهای جاوا اسکریپت، بهترین شیوه‌های زیر را در نظر بگیرید:

دکوراتورها را ساده نگه دارید: دکوراتورها باید متمرکز باشند و یک کار واحد و به خوبی تعریف شده را انجام دهند. از منطق پیچیده در داخل دکوراتورها برای حفظ خوانایی و قابلیت نگهداری خودداری کنید.
از کارخانه‌های دکوراتور استفاده کنید: از کارخانه‌های دکوراتور برای امکان ایجاد دکوراتورهای قابل تنظیم استفاده کنید. این کار دکوراتورهای شما را انعطاف‌پذیرتر و قابل استفاده مجدد می‌کند.
از اثرات جانبی (Side Effects) خودداری کنید: دکوراتورها باید در درجه اول بر اصلاح عنصر تزئین‌شده یا مرتبط کردن فراداده با آن تمرکز کنند. از انجام اثرات جانبی پیچیده در داخل دکوراتورها که می‌تواند درک و اشکال‌زدایی کد شما را دشوارتر کند، خودداری کنید.
از تایپ اسکریپت استفاده کنید: تایپ اسکریپت پشتیبانی عالی از دکوراتورها، از جمله بررسی نوع و IntelliSense، را فراهم می‌کند. استفاده از تایپ اسکریپت می‌تواند به شما در شناسایی زودهنگام خطاها و بهبود تجربه توسعه کمک کند.
دکوراتورهای خود را مستند کنید: دکوراتورهای خود را به وضوح مستند کنید تا هدف و نحوه استفاده از آنها را توضیح دهید. این کار درک و استفاده صحیح از دکوراتورهای شما را برای سایر توسعه‌دهندگان آسان‌تر می‌کند.
عملکرد را در نظر بگیرید: در حالی که دکوراتورها قدرتمند هستند، می‌توانند بر عملکرد نیز تأثیر بگذارند. به پیامدهای عملکردی دکوراتورهای خود، به ویژه در برنامه‌های حساس به عملکرد، توجه داشته باشید.

نمونه‌هایی از بین‌المللی‌سازی با دکوراتورها

دکوراتورها می‌توانند با مرتبط کردن داده‌ها و رفتارهای مختص هر منطقه (locale) به اجزای کد، در بین‌المللی‌سازی (i18n) و محلی‌سازی (l10n) کمک کنند:

مثال: قالب‌بندی تاریخ محلی‌شده

import 'reflect-metadata';

interface DateFormatOptions {
  locale: string;
  options?: Intl.DateTimeFormatOptions;
}

const dateFormatKey = 'dateFormat';

function formatDate(options: DateFormatOptions) {
  return function(target: any, propertyKey: string) {
    Reflect.defineMetadata(dateFormatKey, options, target, propertyKey);
  };
}

class Event {
  @formatDate({ locale: 'fr-FR', options: { year: 'numeric', month: 'long', day: 'numeric' } })
  startDate: Date;

  constructor(startDate: Date) {
    this.startDate = startDate;
  }

  getFormattedStartDate(): string {
    const options: DateFormatOptions = Reflect.getMetadata(dateFormatKey, Object.getPrototypeOf(this), 'startDate');
    return this.startDate.toLocaleDateString(options.locale, options.options);
  }
}

const event = new Event(new Date());
console.log(event.getFormattedStartDate()); // تاریخ را با فرمت فرانسوی خروجی می‌دهد

مثال: قالب‌بندی ارز بر اساس موقعیت مکانی کاربر

import 'reflect-metadata';

interface CurrencyFormatOptions {
  locale: string;
  currency: string;
}

const currencyFormatKey = 'currencyFormat';

function formatCurrency(options: CurrencyFormatOptions) {
  return function(target: any, propertyKey: string) {
    Reflect.defineMetadata(currencyFormatKey, options, target, propertyKey);
  };
}

class Product {
  @formatCurrency({ locale: 'de-DE', currency: 'EUR' })
  price: number;

  constructor(price: number) {
    this.price = price;
  }

  getFormattedPrice(): string {
    const options: CurrencyFormatOptions = Reflect.getMetadata(currencyFormatKey, Object.getPrototypeOf(this), 'price');
    return this.price.toLocaleString(options.locale, { style: 'currency', currency: options.currency });
  }
}

const product = new Product(99.99);
console.log(product.getFormattedPrice()); // قیمت را با فرمت یوروی آلمان خروجی می‌دهد

ملاحظات آینده

دکوراتورهای جاوا اسکریپت یک ویژگی در حال تکامل هستند و استاندارد آن هنوز در حال توسعه است. برخی از ملاحظات آینده عبارتند از:

استانداردسازی: استاندارد ECMAScript برای دکوراتورها هنوز در حال پیشرفت است. با تکامل استاندارد، ممکن است تغییراتی در سینتکس و رفتار دکوراتورها ایجاد شود.
بهینه‌سازی عملکرد: با استفاده گسترده‌تر از دکوراتورها، نیاز به بهینه‌سازی عملکرد برای اطمینان از عدم تأثیر منفی آنها بر عملکرد برنامه وجود خواهد داشت.
پشتیبانی ابزارها: پشتیبانی بهتر ابزارها از دکوراتورها، مانند یکپارچه‌سازی با IDE و ابزارهای اشکال‌زدایی، استفاده مؤثر از دکوراتورها را برای توسعه‌دهندگان آسان‌تر خواهد کرد.

نتیجه‌گیری

دکوراتورهای جاوا اسکریپت ابزاری قدرتمند برای پیاده‌سازی برنامه‌نویسی فراداده و تقویت رفتار کد شما هستند. با استفاده از دکوراتورها، می‌توانید عملکرد را به روشی تمیز، اعلانی و قابل استفاده مجدد اضافه کنید. این منجر به کدی قابل نگهداری‌تر، قابل آزمایش‌تر و مقیاس‌پذیرتر می‌شود. درک انواع مختلف دکوراتورها و نحوه استفاده مؤثر از آنها برای توسعه مدرن جاوا اسکریپت ضروری است. دکوراتورها، به ویژه هنگامی که با Reflect Metadata API ترکیب شوند، طیف وسیعی از امکانات را، از تزریق وابستگی و اعتبارسنجی گرفته تا سریال‌سازی و مسیریابی، باز می‌کنند و کد شما را گویاتر و مدیریت آن را آسان‌تر می‌کنند.